home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / maximus / sqrep103.zip / SQREPORT.DOC < prev    next >
Text File  |  1992-03-08  |  8KB  |  204 lines
  1. If you are upgrading from version 0.8 or 0.9, check the READTHIS file for
  2. information on converting your data files.
  3.  
  4.  
  5.                              S q R e p o r t
  6.                              ~~~~~~~~~~~~~~~
  7. Bob Rakov, 1:203/53
  8. The Second Opinion BBS
  9. Folsom, CA
  10.  
  11. 16 Feb 92, version 1.0
  12.  
  13.   SqReport is a utility to report on the mail activity of your system based
  14. on the log output from the SQUISH (version 1.0) mail tosser/scanner.
  15.  
  16.   SqReport can scan your squish log (or the database you create) and provide
  17. information regarding number of messages received, echomail packed for nodes
  18. you feed, traffic reports for individual echoes and a report of dead areas.
  19.  
  20.  
  21. Input
  22. -----
  23.   The input for SqReport can be either your squish log, a database previously
  24. created by SqReport or both; the log plus the database.
  25.  
  26. Output
  27. ------
  28.   The output for SqReport can be either local console, a specified report
  29. file, database or any combination of the three.  The database option is
  30. useful for cumulative reports (weekly, monthly etc.)
  31.  
  32. HOW IT WORKS:
  33. -------------
  34.   SqReport doesn't need to be in the current directory.  If you do not store
  35. it in your path, then prefix your call to SqReport with the drive and
  36. directory location of the program.
  37.  
  38. Options Explained
  39. -----------------
  40.   All options must be preceded by a '-'
  41.  
  42. SqReport -? yields the information screen:
  43.  
  44. Syntax --> SQreport [-lLogFile] [-dDataFile] [-rReportFile] [-k] [-q]
  45.                     [-aAreaFile] [-sAreaFile] [-iNumber] [-oNumber]
  46.                     [-cConfigFile]
  47.  
  48. -lLogFile
  49. ---------
  50.    This is the name of the log file created by SQUISH.  If it is not in the
  51. current directory, it must be preceded by the drive\directory location of
  52. the log file.  This file is optional, but if you don't specify a log file,
  53. you need to specify a data file in order for SqReport to have something
  54. useful to do.  You can specify _both_ a log and data file.
  55.  
  56. -dDataFile
  57. ----------
  58.    This is the name of the data file created by SqReport.  If it is not in
  59. the current directory, or you don't want a data file created in the current
  60. directory, it must be preceded by the drive\directory location of the data
  61. file.  This file is optional, but if you don't specify a data file, you need
  62. to specify a log file in order for SqReport to have something useful to do.
  63. You can specify _both_ a data and log file.
  64.  
  65. -rReportFile
  66. ------------
  67.    This is the name of the report file created by SqReport.  If you don't
  68. want the report file created in the current directory, it must be preceded
  69. by the drive\directory location where you would like the report created.
  70. This file is optional, if you don't specify a report file, and the 'quiet'
  71. option is not on, the output will be sent to the local console.
  72.  
  73.  
  74. -aAreaFile               -sAreafile
  75. ----------   AND / OR    ----------
  76.  Areas.Bbs                Squish.Cfg
  77.  
  78.    You may specify an areas.bbs file (-aAreas.Bbs) and/or a Squish.Cfg file
  79. in order to tell SqReport the areas you carry.
  80.  
  81.    This is the name of your areas.bbs file for squish. If it is not in the
  82. current directory, it must be preceded by the drive\directory location of
  83. the file.  This file is optional.  If you specify an areas.bbs file SqReport
  84. will compare the echoes listed within to the echoes for which you've tossed
  85. or scanned mail and produce a list of 'dead' echoes - ripe for deletion.  The
  86. format of this file must stricly adhere to the format described within the
  87. sample areas.bbs and sample squish.cfg included with the SQUISH 1.0 archive.
  88.  
  89. -iNUMBER  <messages>
  90. --------
  91.    This is the threshold number messages for SqReport to use in producing a
  92. report of inbound mail (either to the screen or report file).  If a node
  93. sends you greater than the theshold number of messages, it will be listed as
  94. having sent the messages.  If it has sent the threshold or below number of
  95. messages, the messages it sent will be listed under messages from 'other'
  96. systems.  The default is 0, and all nodes sending you messages will have
  97. their address listed.
  98.  
  99. -oNUMBER  <bytes>
  100. --------
  101.    This is the threshold number bytes for SqReport to use in producing a
  102. report of outbound mail (either to the screen or report file).  If a node
  103. receives greater than the theshold number of bytes from you, it will be
  104. listed in the output.  If it receives the threshold or below number of bytes
  105. from you, the number of bytes it receives will be listed under mail to
  106. 'other' systems.  The default is 0, and all nodes you send mail to will have
  107. their address listed.  This option only affects screen & report file output.
  108. If a data file is specified, the information for the individual nodes (up to
  109. 512) is maintained regardless of this setting.
  110.  
  111. -k
  112. --
  113.    Kill.  If a log is specified, kill it after processing.
  114.  
  115. -q
  116. --
  117.   Quiet.  Supress screen output.  This is a bit faster if all you're doing is
  118. updating the data file and/or creating a report file and don't need screen
  119. output.
  120.  
  121. -cConfigFile
  122. ------------
  123.    All options specified on the command line can also be specified in a
  124. configuration file.  The command line options take priority and can override
  125. the options specified in the config file.  Command line parameters issued
  126. with no modifiers can be used to cancel config file options.  For instance,
  127. entering  -l -d -r -s -d -i -o with no modifiers will cancel whatever
  128. cooresponding option was set in the config file.  Entering any of these with
  129. a modifier will override whatever was set in the config file.
  130.  
  131.  
  132. EXAMPLES:
  133. ---------
  134.  
  135. :DoDay
  136.  SqReport -lSquish.Log -rDaily.Rpt -i10 -o30000 -q
  137.  SqReport -lSquish.Log -dWeekly.Dat -rWeekly.Rpt -i10 -o30000 -q
  138.  SqReport -lSquish.Log -dMonthly.Dat -rMonthly.Rpt -i10 -o30000 -q -k
  139.  
  140. Daily, I run three passes of SqReport:
  141.  
  142. First pass scans squish.log and creates the daily report, listing nodes that
  143. have either sent me > 10 messages or received > 30k from me.
  144.  
  145. Second pass scans squish.log and updates (or creates) a weekly data file.  It
  146. then creates a report of what the traffic has been thusfar this week.
  147.  
  148. Third pass does the same thing as the second, only this time updating (or
  149. creating) a monthly data file and creating a report of what the traffic has
  150. been thusfar this month.  The log file is deleted after the final pass.
  151.  
  152. :DoWeek
  153.  SqReport -dWeekly.Dat -rWeekly.Out -aAreas.Bbs -i10 -o30000
  154.  erase weekly.dat
  155.  
  156. Once per week I create a report for distribution to my nodes using the weekly
  157. data file created above.  Note here that no log was specified and that I'm
  158. using Areas.Bbs to create a list of 'dead' echoes.  After generating the
  159. report, I delete the weekly data file.  The next time the second of the three
  160. daily passes described above is run, a fresh weekly data file will be
  161. created.
  162.  
  163. I then use the enclosed program CARVE to carve up the rather long report into
  164. message sized chunks and place then in the local sysop echo.  See the
  165. enclosed CARVE.DOC for further information.
  166.  
  167.  
  168. :DoMonth
  169.  SqReport -dMonthly.Dat -rMonthly.Out -Aareas.Bbs -i10 -o30000
  170.  erase c:\squish\monthly.dat
  171.  
  172. Same as the weekly routine, only this time the activity for the entire month
  173. is tabulated.
  174.  
  175.  
  176. LIMITATIONS:
  177. ------------
  178.  
  179. 1024 unique echo areas.
  180.  
  181. 512  Unique addresses to list mail from/to.  After 512 different nodes have
  182. sent/received mail, the messages in / bytes out data is will be listed under
  183. 'other'.
  184.  
  185. WARRANTEE:
  186. ----------
  187.  
  188. Get real.
  189.  
  190. Dammit Jim, I'm a Doctor not a Programmer.
  191.  
  192. if BROKE then
  193.   user:='Owns Both Pieces'
  194.  
  195. if PROBLEMS/SUGGESTIONS then
  196.   contact:='Bob Rakov, The Second Opinion, 1:203/53'
  197.  
  198. if COMPLAINTS then
  199.   send to device > nul
  200.  
  201. For the latest version, request SQREPORT from 1:203/53 (HST/DS)
  202.  
  203.                  -bob
  204.